$Id: README,v 1.9 1999/07/13 17:35:32 daven Exp $
Copyright (C) 1995 - 1998, Hewlett-Packard Company, all rights reserved.
Written by Eric Backus

This is the README file for E1432 hostlib directory.

This directory contains the source code to the E1432 host interface
library.  For more information on the use of this library, check out
the manual pages in /usr/e1432/man.

The Makefile in this directory can be used to create various versions
of the host interface library.  Here are the versions we create:

lib1432.a	A normal unix archive library, used by host programs
		wanting to talk to E1432 hardware.

lib1432.sl	An HP-UX shared library, used by host programs wanting
		to talk to E1432 hardware.  This and the above archive
		library do exactly the same things.  Usually, host
		programs would use the shared library, because it
		makes the host program smaller.

lib1432.pio	A large .o object file containing all of the .o files
		that are used to create the .sl shared library.  This
		is used by E3202 rather than the shared library, for
		some obscure reason I don't know.  I also don't know
		why they call it "lib1432.pio" rather than
		"lib1432.o", which seems like a much more obvious name
		to me.

hpe1432.sl	A VXI Plug&Play version of lib1432.sl.

libd1432.a	An E1485 downloadable library, used by E1485
		downloaded programs wanting to talk to E1432
		hardware.

llib-l1432.ln	A lint library for the E1432 host interface library.
		If you don't use lint (a unix tool for checking your
		source code for problems), you won't care about this
		file.

Here is a brief description of each source file in this directory:

Makefile	The Makefile for creating the host interface library.

README		The file you are reading now.

analog.c	Contains e1432_set_analog_input.

auto.c		Contains e1432_auto_range and e1432_auto_zero.

data.c		Contains e1432_set_data_format.

debugio.c	Contains e1432_write_dsp_mem and related functions to
		do I/O to the substrate 96002 address space.

decomp.c	Contains code for LZHUF decompression, sometimes used
		by e1432_install.

diag1432.c	Contains utility functions for self-test.

diag1432.def	Something to do with a Windows DLL for E1432 diagnostics.

diag1432.mak	Microsoft Visual C++ generated build script for E1432
		diagnostics.

diag_son.asc	Image to download to an E1433 during diagnostics.

display.c	Contains e1432_display_state.

e1432.bas	Visual Basic prototypes for the E1432 Windows DLL.  I
		believe this is used only for the 16-bit windows
		version of the production front panel.  Anyone wanting
		to use VB with an E1432 should probably use
		hpe1432.bas instead.

e1432.def	Something to do with the E1432 Windows DLL.

e1432.h		External include file for all applications using the
		E1432 host interface library.

e1432.mak	Microsoft Visual C++ generated build script for E1432.dll.  
		E1432.dll is a 16bit application compiled with Microsoft 
		VC++1.52 and is used by manufacturing's Frontp32.exe.

e1432i.h	Internal include file for things used by both the host
		interface library, and the substrate 96002 firmware.

err1432.bas	Visual Basic prototypes for the E1432 Windows DLL.  I
	      	believe this is used only for the 16-bit windows
		version of the production front panel.  Anyone wanting
		to use VB with an E1432 should probably use
		hpe1432.bas instead.

err1432.h	External include file for applications using the E1432
		host interface library.  This contains only #defines
		for all of the errors we can return.

error.c		Contains functions for dealing with errors.

filter.c	Contains e1432_get_decimation_bandwidth,
		e1432_set_decimation_bandwidth, and
		e1432_set_decimation_filter.  For the most part, these
		functions are obsolete, use e1432_set_span instead.

fwrev.c		Contains code to get a revision string from a sema.bin
		file.

getdata.c	Contains functions for reading input data from the
		E1432 module.

global.h	Internal header file containing all global variables.

hpe1432.bas	Visual Basic prototypes for the VXI Plug&Play library.

hpe1432.c	VXI Plug&Play wrapper around the E1432 host interface
		library.

hpe1432.cnt	Something to do with the hpe1432.hlp help file.

hpe1432.d1	Source for creating Plug&Play help file.

hpe1432.def	Something to do with the Plug&Play E1432 Windows DLL.

hpe1432.fp	Something to do with the Plug&Play E1432 driver.

hpe1432.h	Include file for VXI Plug&Play version of the E1432
		host interface library.

hpe1432.hlp	Windows version of Plug&Play help file.

hpe1432.kb	I don't know what this is.

hpe1432.matio	Something to help Matlab use E1432 functions.

hpe1432.unixhlp	Unix version of Plug&Play help file.

hpe1433.kb	I don't know what this is.

hpe1434.kb	I don't know what this is.

i2c.c		Contains code allowing the host to send arbitrary I2C
		commands to arbitrary I2C addresses on the E1432 I2C
		bus.  Probably not needed or used by anyone.

install.c	Contains e1432_install and related code.

intr.c		Contains e1432_set_interrupt and code related to
		interrupts from the E1432 hardware.

io.c		Contains low-level I/O routines used by the library.

lintlib.c	Used internally to check consistency of the host
		interface library source code.

llib-l1432.c	Source for the llib-l1432.ln lint library we ship.

machType.h	Definitions for the stupid SHORTSIZ16, FLOATSIZ32, and
		so on, that we use.

machine.c	Machine-dependent code.  Well, that's what it was
		going to be.

meas.c		Contains functions for starting, stopping, triggering,
		and arming measurements.

modgroup.c	Contains code dealing the grouping modules and
		channels into groups.

octave.c	Contains code for talking to the E1433 1D1 Real Time
		Octave option.

parms.c		The macros from hell.  These create almost all of the
		parameter set and get routines.

plugadder	Something to do with Plug&Play.

sca.c		Contains code for download code to E1433 SCAs.

selftest.c	Contains E1432 self-test functions.

sema.h		Internal header file for internal functions and
		structures.

set.c		Low-level routines for setting and getting
		parameters.

siclimap.c	Deals with the quirks of the HP-UX SICL memory mapping
		functions.

sim1432.c	Contains code to simulate talking to an E1432 module.

srcdata.c	Contains arb source data transfer functions.

syscalls.h	Include file used by e1432mon, the E1432 system call
		monitoring program.

testmem.c	Self-test of E1432 memory.

testsbst.c	Self-test of E1432 substrate board.

testsca.c	Self-test of E1432 SCAs.

timing.c	Functions dealing with TTLTRG lines and synchronizing
		multiple E1432 modules.

trigger.c	Contains e1432_set_trigger and e1432_send_trigger.

visa.h		Include file for the VISA I/O Library

visatype.h	Declares fundamental VISA I/O data types and macros.

vpptype.h	VXI Plug&Play instrument driver header file

vtlio.c		Low-level I/O routines using VTL instead of SICL.

zap.c		Contains functions relating to Flash ROM.

The following files are checked into the source tree, but don't appear
to be used right now:

edf.d1
edfadder.d1
hpe1432.basedf
hpe1432.cntedf
hpe1432.defedf
hpe1432.fpedf
hpe1432.hedf
hpe1432.hlpedf
hpe1432.unixhlpedf
